Get all variables in a Master Flow
{ getMasterFlowVariables }
Returns a listing of all Master Flow variables.
Method
/API3/dataSources/getMasterFlowVariables
Input Parameters
Name
itemId
Type
string
Description
The item's system ID
Output Response
Successful Result Code
200
Response Type
Description of Response Type
List of variables based on a query with all their connection details
Notes
The response list of variables includes all their details, including name, current value and type.The item's system ID depends on the source: For Model files it is the item's system ID. For materialized/deployed models it is its materialized model ID.
Code Snippets
JavaScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/dataSources/getMasterFlowVariables" \
-d ''
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;
import java.util.*;
public class DataSourcesServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
// Initialize the itemId parameter object for the call
String itemId = itemId_example; // String |
try {
MasterFlowVariablesResult result = apiInstance.getMasterFlowVariables(itemId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataSourcesServiceApi#getMasterFlowVariables");
e.printStackTrace();
}
}
}
const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
// Configure API key authorization: paToken
const paToken = defaultClient.authentications['paToken'];
paToken.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.apiKeyPrefix['paToken'] = "Token";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")
const itemId = itemId_example; // {String}
const callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getMasterFlowVariables(itemId, callback);
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class getMasterFlowVariablesExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new DataSourcesServiceApi();
// Initialize the itemId parameter object for the call
var itemId = itemId_example; // String |
try {
// Returns a listing of all Master Flow variables.
MasterFlowVariablesResult result = apiInstance.getMasterFlowVariables(itemId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DataSourcesServiceApi.getMasterFlowVariables: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# api_config.api_key_prefix['paToken'] = 'Bearer'
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = com.pyramidanalytics.DataSourcesServiceApi(api_client)
# Initialize the itemId parameter object for the call
itemId = itemId_example # String |
try:
# Returns a listing of all Master Flow variables.
api_response = api_instance.get_master_flow_variables(itemId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataSourcesServiceApi->getMasterFlowVariables: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$itemId = itemId_example; // String |
try {
$result = $api_instance->getMasterFlowVariables($itemId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesServiceApi->getMasterFlowVariables: ', $e->getMessage(), PHP_EOL;
}
?>
Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.